Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📄 🐛 Source Netsuite: check_connection fix + edited public docs #21645

Merged
merged 3 commits into from
Jan 21, 2023

Conversation

bazarnov
Copy link
Collaborator

What

  • Need to correct public docs to clarify the Setup Guide steps

How

  • Fixed the issue with Realm (Account ID) processed incorrectly for the auth method and the base_url methods.
  • edited the public docs along with reproduction steps

🚨 User Impact 🚨

No impact is expected.

Pre-merge Checklist

Expand the relevant checklist and delete the others.

Updating a connector

Community member or Airbyter

  • Unit & integration tests added and passing. Community members, please provide proof of success locally e.g: screenshot or copy-paste unit, integration, and acceptance test output. To run acceptance tests for a Python connector, follow instructions in the README. For java connectors run ./gradlew :airbyte-integrations:connectors:<name>:integrationTest.
  • Code reviews completed
  • Documentation updated
    • Connector's README.md
    • Connector's bootstrap.md. See description and examples
    • Changelog updated in docs/integrations/<source or destination>/<name>.md including changelog. See changelog example
  • PR name follows PR naming conventions

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

  • Create a non-forked branch based on this PR and test the below items on it
  • Build is successful
  • If new credentials are required for use in CI, add them to GSM. Instructions.
  • /test connector=connectors/<name> command is passing
  • New Connector version released on Dockerhub and connector version bumped by running the /publish command described here

@bazarnov bazarnov requested a review from YowanR January 20, 2023 12:17
@octavia-squidington-iv octavia-squidington-iv added the area/documentation Improvements or additions to documentation label Jan 20, 2023
@bazarnov
Copy link
Collaborator Author

bazarnov commented Jan 20, 2023

@YowanR please check out the rendered version of the corrected Public Docs for Netsuite: https://github.com/airbytehq/airbyte/blob/4c078e6a1bbcbd32bf9849e07cd32ac3bb4fde90/docs/integrations/sources/netsuite.md

It turns out that the Netsuite used to have the Full Access Role, which came up in the list of Roles and could be assigned to any other Custom Role created, which was very convenient for the users because it gave all the necessary permissions and other points out-of-the-box.
Now it's deprecated: https://docs.oracle.com/en/cloud/saas/netsuite/ns-online-help/section_1557254595.html
More info about this from 3rd-party: https://support.cazoomi.com/hc/en-us/articles/204089345-Manage-NetSuite-Permissions-

Therefore, creating and manually populating the Custom Role with all the necessary permissions is required, it could be reused for all subsequently created users, once needed, but it should be done at least 1 time (!)
The Administrator role is not recommended to leverage for the integration to work (for security reasons), so this is not an option, the custom role should be created and applied for the integration.

@bazarnov
Copy link
Collaborator Author

bazarnov commented Jan 20, 2023

/test connector=connectors/source-netsuite

🕑 connectors/source-netsuite https://github.com/airbytehq/airbyte/actions/runs/3967631049
✅ connectors/source-netsuite https://github.com/airbytehq/airbyte/actions/runs/3967631049
Python tests coverage:

	 Name                                                 Stmts   Miss  Cover   Missing
	 ----------------------------------------------------------------------------------
	 source_acceptance_test/base.py                          12      4    67%   16-19
	 source_acceptance_test/config.py                       141      5    96%   87, 93, 239, 243-244
	 source_acceptance_test/conftest.py                     211     95    55%   36, 42-44, 49, 54, 77, 83, 89-91, 110, 115-117, 123-125, 131-132, 137-138, 143, 149, 158-167, 173-178, 193, 217, 248, 254, 262-267, 275-285, 293-306, 311-317, 324-335, 342-358
	 source_acceptance_test/plugin.py                        69     25    64%   22-23, 31, 36, 120-140, 144-148
	 source_acceptance_test/tests/test_core.py              402    115    71%   53, 58, 93-104, 109-116, 120-121, 125-126, 308, 346-363, 376-387, 391-396, 402, 435-440, 478-485, 528-530, 533, 598-606, 618-621, 626, 682-683, 689, 692, 728-738, 751-776
	 source_acceptance_test/tests/test_incremental.py       160     14    91%   58-65, 70-83, 246
	 source_acceptance_test/utils/asserts.py                 39      2    95%   62-63
	 source_acceptance_test/utils/common.py                  94     10    89%   16-17, 32-38, 72, 75
	 source_acceptance_test/utils/compare.py                 62     23    63%   21-51, 68, 97-99
	 source_acceptance_test/utils/connector_runner.py       133     33    75%   24-27, 46-47, 50-54, 57-58, 73-75, 78-80, 83-85, 88-90, 93-95, 124-125, 159-161, 208
	 source_acceptance_test/utils/json_schema_helper.py     107     13    88%   30-31, 38, 41, 65-68, 96, 120, 192-194
	 ----------------------------------------------------------------------------------
	 TOTAL                                                 1609    339    79%

Build Passed

Test summary info:

=========================== short test summary info ============================
SKIPPED [1] ../usr/local/lib/python3.9/site-packages/source_acceptance_test/tests/test_core.py:94: The previous and actual specifications are identical.
SKIPPED [1] ../usr/local/lib/python3.9/site-packages/source_acceptance_test/tests/test_core.py:377: The previous and actual discovered catalogs are identical.
=========== 29 passed, 2 skipped, 31 warnings in 4920.00s (1:22:00) ============

@bazarnov
Copy link
Collaborator Author

bazarnov commented Jan 20, 2023

/publish connector=connectors/source-netsuite

🕑 Publishing the following connectors:
connectors/source-netsuite
https://github.com/airbytehq/airbyte/actions/runs/3971117168


Connector Did it publish? Were definitions generated?
connectors/source-netsuite

if you have connectors that successfully published but failed definition generation, follow step 4 here ▶️

@octavia-squidington-iii octavia-squidington-iii temporarily deployed to more-secrets January 20, 2023 22:31 — with GitHub Actions Inactive
@octavia-squidington-iii octavia-squidington-iii temporarily deployed to more-secrets January 20, 2023 22:31 — with GitHub Actions Inactive
@github-actions
Copy link
Contributor

Airbyte Code Coverage

There is no coverage information present for the Files changed

Total Project Coverage 26.75% 🍏

@bazarnov bazarnov merged commit b0e5ea9 into master Jan 21, 2023
@bazarnov bazarnov deleted the baz/source-netsuite-minor-fix branch January 21, 2023 10:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/connectors Connector related issues area/documentation Improvements or additions to documentation connectors/source/netsuite team/connectors-python
Projects
No open projects
Status: No status
Development

Successfully merging this pull request may close these issues.

4 participants